<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: session/session_fwd.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_938858dd290fe54e59e3500689c41d32.html">session</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">session_fwd.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="session__fwd_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Sessions</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="detail_2session__fwd_8hpp.html">ipc/session/detail/session_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="transport__fwd_8hpp.html">ipc/transport/transport_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="struc__fwd_8hpp.html">ipc/transport/struc/struc_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="util__fwd_8hpp.html">ipc/util/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;<a class="code" href="native__handle_8hpp.html">ipc/util/native_handle.hpp</a>&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"></span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment">/**</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> * Flow-IPC module providing the broad lifecycle and shared-resource organization -- via the *session* concept --</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> * in such a way as to make it possible for a given pair of processes A and B to set up ipc::transport</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * structured- or unstructured-message channels for general IPC, as well as to share data in</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * SHared Memory (SHM).  See namespace ::ipc doc header for an overview of Flow-IPC modules</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * including how ipc::session relates to the others.  Then return here.  A synopsis follows:</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> *</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * It is possible to use the structured layer of ipc::transport, namely the big daddy transport::struc::Channel,</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * without any help from ipc::session.  (It&#39;s also possible to establish unstructured transport::Channel and</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * the various lower-level IPC pipes it might comprise.)  And, indeed,</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * once a given `struc::Channel` (or `Channel`) is &quot;up,&quot; one can and *should*</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * simply use it to send/receive stuff.  The problem that ipc::session solves is in establishing</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * the infrastructure that makes it simple to (1) open new `struc::Channel`s or `Channel`s or SHM areas;</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * and (2) properly deal with process lifecycle events such as the starting and ending (gracefully or otherwise) of</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * the local and partner process.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> *</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * Regarding (1), in particular (just to give a taste of what one means):</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *   - What underlying low-level transports will we even be using?  MQs?  Local (Unix domain) stream sockets?</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *     Both?</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *   - For each of those, we must connect or otherwise establish each one.  In the case of MQs, say, there has</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *     to be an agreed-upon util::Shared_name for the MQ in each direction... so what is that name?</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *     How to prevent collisions in this name?</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> *</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> * While ipc::transport lets one do whatever one wants, with great flexibility, ipc::session establishes conventions</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * for all these things -- typically hiding/encapsulating them away.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * Regarding (2) (again, just giving a taste):</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> *   - To what process are we even talking?  What if we want to talk to 2, or 3, processes?  What if we want to talk</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> *     to 1+ processes of application X and 1+ processes of application Y?  How might we segregate the data</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> *     between these?</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> *   - What happens if 1 of 5 instances of application X, to whom we&#39;re speaking, goes down?  How to ensure cleanup</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> *     of any kernel-persistence resources, such as the potentially used POSIX MQs, or even of SHM (ipc::shm)?</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> *</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * Again -- ipc::session establishes conventions for these lifecycle matters and provides key utilities such as</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * kernel-persistent resource cleanup.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> *</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * ### Basic concepts ###</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> * An *application* is, at least roughly speaking, 1-1 with a distinct executable presumably interested in</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * communicating with another such executable.  A *process* is a/k/a *instance* of an application that has begun</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * execution at some point.  In the IPC *universe* that uses ::ipc, on a given machine, there is some number</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * of distinct applications.  If two processes A and B want to engage in IPC, then their apps A and B comprise</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * a meta-application *split*, in that (in a sense) they are one meta-application that have been split into two.</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> *</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> * A process that is actively operating, at least in the IPC sense, is called an *active* process.  A zombie</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> * process in particular is not active, nor is one that has not yet initialized IPC or has shut it down, typically</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> * during graceful (or otherwise) termination.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> *</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> * In the ipc::session model, any two processes A-B must establish a *session* before engaging in IPC.  This</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> * *session* comprises all *shared resources* pertaining to those two *processes* engaging in IPC.  (Spoiler alert:</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> * at a high level these resources comprise, at least, *channels* of communication -- see transport::Channel --</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> * between them; and may also optionally comprise SHared Memory (SHM).)  The session ends when either A terminates</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * or B terminates (gracefully or otherwise), and no earlier.  The session begins at roughly the earliest time</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * when *both* A and B are active simultaneously.  (It is possible either process may run before IPC and after IPC,</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> * but for purposes of our discussion we&#39;ll ignore such phases are irrelevant for simplicity of exposition.)</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> * An important set of shared resources is therefore *per-session shared resources*.  (However, as we&#39;re about to</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> * explain, it is not the only type.)</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> *</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * In the ipc::session model, in a given A-B split, one must be chosen as the *client*, the other as the *server*;</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * let&#39;s by convention here assume they&#39;re always listed in server-client order.  The decision must be made which</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * one is which, at compile time.  The decision as to which is which is an important one, when using ipc::session</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * and IPC in that model.  While a complete discussion of making that decision is outside the scope here, the main</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * points are that in the A-B split (A the server, B the client):</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> *   - For each *process* pair A-B, there are per-session shared resources, as described above, and as pertains</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> *     to these per-session resources A is no different from B.  Once either terminates, these resources</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> *     are not usable and shall be cleaned up as soon as possible to free RAM/etc.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> *   - There may be multiple (active) instances of B at a given time but only one (active) instance of A.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> *   - Accordingly, A is special in that it may maintain some *per-app shared resources* (cf. per-session ones)</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> *     which persist even when a given B *process* terminates (thus that A-B session ends) and are available</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> *     for access both by</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> *     - other concurrently active instances of B; and</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> *     - any future active instances of B.</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> * More specifically/practically:</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> *   - *Channels* are between the 2 processes A-B in session A-B.  If B1 and B2 are instances of (client) app Bp,</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> *     a channel cannot be established between B1 and B2; only A-B1 and A-B2.  So channels are always *per-session*.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> *   - A *SHM area* may exist in the *per-session* scope.  Hence A-B1 have a per-session SHM area; and A-B2 have</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> *     a per-session SHM area.  When the session ends, that SHM area goes away.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> *   - A *SHM area* may exist in the *per-app* scope.  Hence A-B* have a per-app-B SHM area, which persists</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> *     throughout the lifetime of (server) process A and remains available as B1, B2, ... start and stop.</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> *     It disappears once A stops.  It appears when the first instance of B establishes a session with A</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> *     (i.e., lazily).</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> *</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> * ### Brief illustration ###</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * Suppose A is a memory cache, while B is a cache reader of objects.  A starts;</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> * B1 and B2 start; so sessions A-B1 and A-B2 now exist.  Now each of B1, B2 might establish channel(s) and then</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * use it/them to issue messages and receive messages back.  Now A&lt;-&gt;B1 channel(s) and A&lt;-&gt;B2 channel(s) are</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> * established.  No B1&lt;-&gt;B2 channel(s) can be established.  (Note: transport::Channel and other</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * ipc::transport IPC techniques are -- in and of themselves -- session-unaware.  So B1 could speak to B2.</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> * They just cannot use ipc::session to do so.  ipc::session facilitates establishing channels and SHM</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> * in an organized fashion, and that organization currently does not support channels between instances of</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> * the same client application.  ipc::session is not the only option for doing so.)</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> *</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> * Suppose, in this illustration, that A is responsible both for acquiring network objects (on behalf of B*)</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> * and memory-caching them.  Then B1 might say, via an A-B1 channel, &quot;give me object X.&quot;  A does not have it</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> * in cache yet, so it loads it from network, and saves it in the *per-app-B* SHM area and replies (via</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> * same A-B1 channel) &quot;here is object X: use this SHM handle X&#39;.&quot;  B1 then accesses X&#39; directly in SHM.</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> * Say B2 also says &quot;give me object X.&quot;  It is cached, so A sends it X&#39; again.  Now, say A-B1 session ends,</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> * because B1 stops.  All A-B1 channels go away -- they are per-session resources -- and any per-session-A-B1 SHM</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> * area (which we haven&#39;t mentioned in this illustration) also goes away similarly.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> *</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> * A-B2 continues.  B2 could request X again, and it would work.  Say B3 now starts and requests X.  Again,</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> * the per-app-B SHM area persists; A would send X&#39; to B3 as well.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> *</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> * Now suppose A stops, due to a restart.  This ends A-B2 and A-B3 sessions; and the per-app-B SHM area goes</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> * away too.  Thus the server process&#39;s lifetime encompasses all shared resources in the A-B split.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> * Processes B2 and B3 continue, but they must await for a new active A process (instance) to appear, so that</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> * they can establish new A-B2 and A-B3 sessions.  In the meantime, it is IPC no-man&#39;s-land: there is</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> * no active per-app-B shared resources (SHM in our illustration) and certainly no per-session-A-B* shared</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> * resources either.  Once A-B2 and A-B3 (new) sessions are established, shared resources can begin to be</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> * acquired again.</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> *</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> * This illustrates that:</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> *   - A is the cache server and expected to service multiple cache clients Bs.  This is asymmetric.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> *   - A can maintain shared resources, especially SHM, that outlive any individual B process.  This is asymmetric.</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> *   - A-B channels are relevant only to a given A-B* session.  (Such per-session SHM areas can also exist.)</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> *     This is symmetric between A and a given B instance.</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> *   - No shared resources survive beyond a given cache server A process.  A given client B* must be prepared</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> *     to establish a new session with A when another active instance of A appears, before it can access IPC</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> *     channels or SHM.  In that sense a given *session* is symmetric: it begins when both A and a B* are active,</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> *     and it ends when either of the 2 stops.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> *</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> * ### 2+ splits co-existing ###</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> * The above discussion concerned a particular A-B split, in which by definition A is the server (only 1 active</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> * instance at a time), while B is the client (0+ active instances at a time).</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> *</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> * Take A, in split A-B.  Suppose there is app Cp also.  An A-C split is also possible (as is A-D, A-E, etc.).</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> * Everything written so far applies in natural fashion.  Do note, however, that the per-app scope applies to</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> * a given (client) application, not all client applications.  So the per-app-B SHM area is independent of the</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> * per-app-C SHM area (both maintained by A).  Once the 1st instance of B establishes a session, that SHM area</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> * is lazily created.  Once the 1st instance of C does the same, that separate SHM area is lazily created.</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> * So B1, B2, ... access one per-app SHM area, while C1, C2, ... access another.</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> *</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> * Now consider app K, in split K-A.  Here K is the server, A is the client.  This, also, is allowed, despite</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> * the fact A is server in splits A-B, A-C.  However, there is a natural constraint on A: there can only be</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> * one active process of it at a time, because it is the server in at least 1 split.  It can be a client to</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> * server K; but there would only ever be 1 instance of it establishing sessions against K.</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> *</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> * Informally: This is not necessarily frowned upon.  After all the ability to have multiple concurrently active</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> * processes of a given app is somewhat exotic in the first place.  That said, very vaguely speaking, it is more</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> * flexible to design a given app to only be server in every split in which it participates.</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> *</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> * ### Overview of relevant APIs ###</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> * With the above explained, here is how the ipc::session API operates over these various ideas.</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> *</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> * The simplest items are App (description of an application, which might a client or a server or both),</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> * Client_app (description of an application in its role as a client), and Server_app (you get the idea).</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> * See their doc headers, of course, but basically these are very simple data stores describing the basic</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> * structure of the IPC universe.  Each application generally shall load the same values into its master</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> * lists of these structures.  References to immutable Client_app and Server_app objects are passed into</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> * actual APIs having to do with the Session concept, to establish who can establish sessions with whom and</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> * how.  Basically they describe the allowed splits.</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> * As noted at the very top, the real goal is to open channels between processes and possibly to share data in</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> * SHM between them and others.  To get there for a given process pair A-B, one must establish session A-B, as</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> * described above.  Having chosen which one is A (server) and which is B (client), and loaded Client_app</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> * and Server_app structures to that effect, it is time to manage the sessions.</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> *</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> * An established session is said to be a session in PEER state and is represented on each side by an object</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> * that implements the Session concept (see its important doc header).  On the client side, this impl</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> * is the class template #Client_session.  On the server side, this impl is the class template #Server_session.</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> * Once each respective side has its PEER-state Session impl object, opening channels and operating SHM areas</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> * on a per-session basis is well documented in the Session (concept) doc header and is fully symmetrical</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> * in terms of the API.</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> *</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> * #Client_session does not begin in PEER state.  One constructs it in NULL state, then invokes</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> * `Client_session::sync_connect()` to connect to the server process if any exists; once it fires its handler</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> * successfully, the #Client_session is a Session in PEER state.  If #Client_session, per Session concept requirements,</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> * indicates the session has finished (due to the other side ending session), one must create a new #Client_session</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> * and start over (w/r/t IPC and relevant shared resources).</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> *</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> * Asymmetrically, on the server side, one must be ready to open potentially multiple `Server_session`s.</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> * Firstly create a Session_server (see its doc header).  To open 1 #Server_session, default-construct one</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> * (hence in NULL state), then pass it as the target to Session_server::async_accept().  Once it fires</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> * your handler, you have an (almost-)PEER state Server_session, and moreover you may call</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> * `Server_session::client_app()` to determine the identity of the connecting client app</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> * (via Client_app) which should (in multi-split situations) help decide what to further do with this</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> * Server_session (also, as on the opposing side, now a PEER-state Session concept impl).</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"> * (If A participates in splits A-B and A-C, then the types of IPC work it might do</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"> * with a B1 or B2 is likely to be quite different from same with a C1 or C2 or C3.  If only split A-B is relevant</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"> * to A, then that is not a concern.)</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment"> *</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment"> * As noted, in terms of per-session shared resources, most notably channel communication, a Server_session and</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment"> * Client_session have identical APIs with identical capabilities, each implementing the PEER-state Session concept</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment"> * to the letter.</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"> *</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"> * ### SHM ###</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"> * Extremely important (for performance at least) functionality is provided in the sub-namespace of ipc::session:</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"> * ipc::session::shm.  Please read its doc header now before using the types directly within ipc::session.</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment"> * That will allow you to make an informed choice.</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment"> *</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"> * ### `sync_io`: integrate with `poll()`-ish event loops ###</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment"> * ipc::session APIs feature exactly the following asynchronous (blocking, background, not-non-blocking, long...)</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment"> * operations:</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment"> *   - ipc::session::Session on-error and (optionally) on-passive-channel-open handlers.</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment"> *   - `ipc::session::Client_session::async_conenct()` (same for other, including SHM-aware, variants).</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment"> *   - ipc::session::Session_server::async_accept() (same for SHM-aware variants).</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment"> *</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment"> * All APIs mentioned so far operation broadly in the async-I/O pattern: Each event in question is reported from</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment"> * some unspecified background thread; it is up to the user to &quot;post&quot; the true handling onto their worker thread(s)</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment"> * as desired.</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment"> *</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment"> * If one desires to be informed, instead, in a fashion friendly to old-school reactor loops -- centered on</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment"> * `poll()`, `epoll_wait()`, or similar -- a `sync_io` alternate API is available.  It is no faster, but it may</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment"> * be more convenient for some applications.</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment"> *</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment"> * To use the alternate `sync_io` interface: Look into session::sync_io and its 3 adapter templates:</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment"> *   - ipc::session::sync_io::Server_session_adapter;</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment"> *   - ipc::session::sync_io::Client_session_adapter;</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment"> *   - ipc::session::sync_io::Session_server_adapter.</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment"> *</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment"> * Exactly the aforementioned async APIs are affected.  All other APIs are available without change.</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment"> */</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1session.html">ipc::session</a></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span>{</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span> </div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment"></span> </div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">/// Convenience alias for the commonly used type util::Shared_name.</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">  245</a></span><span class="comment"></span><span class="keyword">using </span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> = <a class="code hl_typedef" href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">util::Shared_name</a>;</div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment"></span> </div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment">/// Convenience alias for the commonly used type transport::struc::Session_token.</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session.html#ade2b302f1a3623e8adc9694568d94d2c">  248</a></span><span class="comment"></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1session.html#ade2b302f1a3623e8adc9694568d94d2c">Session_token</a> = <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc.html#a6751c05fb6582a34c7c47ac470c4a48b">transport::struc::Session_token</a>;</div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span> </div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">// Find doc headers near the bodies of these compound types.</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span> </div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1session_1_1App.html">App</a>;</div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>;</div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="keyword">struct </span><a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>;</div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span> </div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Session_impl_t&gt;</div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1Session__mv.html">Session_mv</a>;</div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span> </div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Server_session_impl_t&gt;</div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session_mv</a>;</div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Client_session_impl_t&gt;</div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1Client__session__mv.html">Client_session_mv</a>;</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span> </div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="keyword">template</span>&lt;schema::MqType S_MQ_TYPE_OR_NONE, <span class="keywordtype">bool</span> S_TRANSMIT_NATIVE_HANDLES, <span class="keyword">typename</span> Mdt_payload = ::capnp::Vo<span class="keywordtype">id</span>&gt;</div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1Session__server.html">Session_server</a>;</div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment"></span> </div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">/**</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment"> * A vanilla `Server_session` with no optional capabilities.  See Server_session_mv (+doc header) for full API as</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment"> * well as its doc header for possible alternatives that add optional capabilities (such as, at least, SHM</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment"> * setup/access).  Opposing peer object: #Client_session.  Emitted by: Session_server.</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment"> *</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="comment"> * The following important template parameters are *knobs* that control the properties of the session;</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment"> * the opposing #Client_session must use identical settings.</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment"> *</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment"> * @tparam S_MQ_TYPE_OR_NONE</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment"> *         Identical to #Client_session.</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment"> * @tparam S_TRANSMIT_NATIVE_HANDLES</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment"> *         Identical to #Client_session.</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment"> * @tparam Mdt_payload</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment"> *         See Session concept.  In addition the same type may be used for `mdt_from_cli_or_null` (and srv-&gt;cli</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment"> *         counterpart) in Session_server::async_accept().  (Recall that you can use a capnp-`union` internally</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment"> *         for various purposes.)</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment"> *</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment"> * @see Server_session_mv for full API and its documentation.</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment"> * @see Session: implemented concept.</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment"> */</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="keyword">template</span>&lt;schema::MqType S_MQ_TYPE_OR_NONE, <span class="keywordtype">bool</span> S_TRANSMIT_NATIVE_HANDLES, <span class="keyword">typename</span> Mdt_payload = ::capnp::Vo<span class="keywordtype">id</span>&gt;</div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session.html#ab01d5bce0ab2f3435ca9dd88d27609dc">  288</a></span><span class="keyword">using </span><a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session</a></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span>  = <a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session_mv&lt;Server_session_impl&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</a>&gt;;</div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment"></span> </div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">/**</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment"> * A vanilla `Client_session` with no optional capabilities.  See Client_session_mv (+doc header) for full API as</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment"> * well as its doc header for possible alternatives that add optional capabilities (such as, at least, SHM</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment"> * setup/access).  Opposing peer object: #Server_session.</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment"> *</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment"> * The following important template parameters are *knobs* that control the properties of the session;</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment"> * the opposing #Server_session must use identical settings.</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment"> *</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment"> * @tparam S_MQ_TYPE_OR_NONE</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment"> *         Session::Channel_obj (channel openable via `open_channel()` on this or other side) type config:</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment"> *         Enumeration constant that specifies which type of MQ to use (corresponding to all available</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment"> *         transport::Persistent_mq_handle concept impls) or to not use one (`NONE`).  Note: This `enum` type is</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment"> *         capnp-generated; see common.capnp for values and brief docs.</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment"> * @tparam S_TRANSMIT_NATIVE_HANDLES</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment"> *         Session::Channel_obj (channel openable via `open_channel()` on this or other side) type config:</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment"> *         Whether it shall be possible to transmit a native handle via the channel.</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment"> * @tparam Mdt_payload</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment"> *         See Session concept.  In addition the same type may be used for `mdt` or `mdt_from_srv_or_null`</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment"> *         in `*_connect()`.  (If it is used for `open_channel()` and/or passive-open and/or `*connect()`</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment"> *         `mdt` and/or `mdt_from_srv_or_null`, recall that you can use a capnp-`union` internally for various</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment"> *         purposes.)</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment"> *</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment"> * @see Client_session_mv for full API and its documentation.</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment"> * @see Session: implemented concept.</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment"> */</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="keyword">template</span>&lt;schema::MqType S_MQ_TYPE_OR_NONE, <span class="keywordtype">bool</span> S_TRANSMIT_NATIVE_HANDLES,</div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span>         <span class="keyword">typename</span> Mdt_payload = ::capnp::Void&gt;</div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session.html#a77d8fda00e1e17f595a6a5d4c44375e7">  318</a></span><span class="keyword">using </span><a class="code hl_class" href="classipc_1_1session_1_1Client__session__mv.html">Client_session</a></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span>  = <a class="code hl_class" href="classipc_1_1session_1_1Client__session__mv.html">Client_session_mv&lt;Client_session_impl&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</a>&gt;;</div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span> </div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">// Free functions.</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment"></span> </div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">/**</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment"> * Utility, used internally but exposed in public API in case it is of general use, that checks that the</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment"> * owner of the given resource (at the supplied file system path) is</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment"> * as specified in the given App (App::m_user_id et al).  If the resource cannot be accessed (not found,</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment"> * permissions...) that system Error_code shall be emitted.  If it can, but the owner does not match,</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment"> * error::Code::S_RESOURCE_OWNER_UNEXPECTED shall be emitted.</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment"> *</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment"> * @param logger_ptr</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment"> *        Logger to use for logging (WARNING, on error only, including `S_RESOURCE_OWNER_UNEXPECTED`).</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment"> * @param path</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment"> *        Path to resource.  Symlinks are followed, and the target is the resource in question (not the symlink).</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment"> * @param app</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment"> *        Describes the app with the expected owner info prescribed therein.</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment"> * @param err_code</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment"> *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment"> *        error::Code::S_RESOURCE_OWNER_UNEXPECTED (check did not pass),</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment"> *        system error codes if ownership cannot be checked.</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment"> */</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1session.html#a0eac87b284d50832334d819a8877cbaa">ensure_resource_owner_is_app</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> fs::path&amp; path, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1App.html">App</a>&amp; app,</div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span>                                  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment"></span> </div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">/**</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment"> * Identical to the other ensure_resource_owner_is_app() overload but operates on a pre-opened `Native_handle`</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment"> * (a/k/a handle, socket, file descriptor) to the resource in question.</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment"> *</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment"> * @param logger_ptr</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment"> *        See other overload.</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="comment"> * @param handle</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment"> *        See above.  `handle.null() == true` causes undefined behavior (assertion may trip).</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="comment"> *        Closed/invalid/etc. handle will yield civilized Error_code emission.</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment"> * @param app</span></div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment"> *        See other overload.</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment"> * @param err_code</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment"> *        See `flow::Error_code` docs for error reporting semantics.  #Error_code generated:</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment"> *        error::Code::S_RESOURCE_OWNER_UNEXPECTED (check did not pass),</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment"> *        system error codes if ownership cannot be checked (invalid descriptor, un-opened descriptor, etc.).</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment"> */</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1session.html#a0eac87b284d50832334d819a8877cbaa">ensure_resource_owner_is_app</a>(flow::log::Logger* logger_ptr, <a class="code hl_struct" href="structipc_1_1util_1_1Native__handle.html">util::Native_handle</a> handle, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1App.html">App</a>&amp; app,</div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span>                                  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span> </div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment"></span> </div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">/**</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment"> * Prints string representation of the given `App` to the given `ostream`.</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment"> *</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment"> * @relatesalso App</span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment"> *</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment"> */</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1App.html">App</a>&amp; val);</div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment"></span> </div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">/**</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment"> * Prints string representation of the given `Client_appp` to the given `ostream`.</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment"> *</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment"> * @relatesalso Client_app</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment"> *</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment"> */</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>&amp; val);</div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment"></span> </div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">/**</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment"> * Prints string representation of the given `Server_app` to the given `ostream`.</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment"> *</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment"> * @relatesalso Server_app</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment"> *</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment"> */</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; val);</div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment"></span> </div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="comment">/**</span></div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment"> * Prints string representation of the given `Session_mv` to the given `ostream`.</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment"> *</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment"> * @relatesalso Session_mv</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment"> *</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment"> */</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Session_impl_t&gt;</div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os,</div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span>                         <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1session_1_1Session__mv.html">Session_mv&lt;Session_impl_t&gt;</a>&amp; val);</div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment"></span> </div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment">/**</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment"> * Prints string representation of the given `Server_session_mv` to the given `ostream`.</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment"> *</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment"> * @relatesalso Server_session_mv</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment"> *</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment"> */</span></div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Server_session_impl_t&gt;</div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os,</div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span>                         <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1session_1_1Server__session__mv.html">Server_session_mv&lt;Server_session_impl_t&gt;</a>&amp; val);</div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment"></span> </div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">/**</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment"> * Prints string representation of the given `Client_session_mv` to the given `ostream`.</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment"> *</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment"> * @relatesalso Client_session_mv</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment"> *</span></div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment"> */</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Client_session_impl_t&gt;</div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1session_1_1Client__session__mv.html">Client_session_mv&lt;Client_session_impl_t&gt;</a>&amp; val);</div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span><span class="comment"></span> </div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span><span class="comment">/**</span></div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment"> * Prints string representation of the given `Session_server` to the given `ostream`.</span></div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment"> *</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span><span class="comment"> * @relatesalso Session_server</span></div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment"> *</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span><span class="comment"> */</span></div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span><span class="keyword">template</span>&lt;schema::MqType S_MQ_TYPE_OR_NONE, <span class="keywordtype">bool</span> S_TRANSMIT_NATIVE_HANDLES, <span class="keyword">typename</span> Mdt_payload&gt;</div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">operator&lt;&lt;</a>(std::ostream&amp; os,</div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span>                         <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1session_1_1Session__server.html">Session_server</a></div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span>                                 &lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;&amp; val);</div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span> </div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span>} <span class="comment">// namespace ipc::session</span></div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span><span class="comment"></span> </div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment">/**</span></div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment"> * `sync_io`-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::session.</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment"> *</span></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment"> * In this case they are given as only a small handful of adapter templates.  Just check out their doc headers.</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment"> */</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno"><a class="line" href="namespaceipc_1_1session_1_1sync__io.html">  470</a></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1session_1_1sync__io.html">ipc::session::sync_io</a></div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span>{</div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span> </div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span> </div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Session&gt;</div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1sync__io_1_1Server__session__adapter.html">Server_session_adapter</a>;</div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Session&gt;</div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1sync__io_1_1Client__session__adapter.html">Client_session_adapter</a>;</div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Session_server&gt;</div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1sync__io_1_1Session__server__adapter.html">Session_server_adapter</a>;</div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span> </div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span><span class="comment">// Free functions.</span></div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span><span class="comment"></span> </div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span><span class="comment">/**</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment"> * Prints string representation of the given `Server_session_adapter` to the given `ostream`.</span></div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment"> *</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span><span class="comment"> * @relatesalso Server_session_adapter</span></div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span><span class="comment"> *</span></div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span><span class="comment"> */</span></div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Session&gt;</div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session_1_1sync__io.html#a940cd2019ccc199984a9be7102885f2d">operator&lt;&lt;</a>(std::ostream&amp; os,</div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span>                         <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1session_1_1sync__io_1_1Server__session__adapter.html">Server_session_adapter&lt;Session&gt;</a>&amp; val);</div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span><span class="comment"></span> </div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span><span class="comment">/**</span></div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="comment"> * Prints string representation of the given `Client_session_adapter` to the given `ostream`.</span></div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="comment"> *</span></div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span><span class="comment"> * @relatesalso Client_session_adapter</span></div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span><span class="comment"> *</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment"> */</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Session&gt;</div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session_1_1sync__io.html#a940cd2019ccc199984a9be7102885f2d">operator&lt;&lt;</a>(std::ostream&amp; os,</div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span>                         <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1session_1_1sync__io_1_1Client__session__adapter.html">Client_session_adapter&lt;Session&gt;</a>&amp; val);</div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span><span class="comment"></span> </div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="comment">/**</span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><span class="comment"> * Prints string representation of the given `Session_server_adapter` to the given `ostream`.</span></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span><span class="comment"> *</span></div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="comment"> * @relatesalso Session_server_adapter</span></div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment"> *</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="comment"> *        Stream to which to write.</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><span class="comment"> * @param val</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span><span class="comment"> *        Object to serialize.</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span><span class="comment"> */</span></div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Session_server&gt;</div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span>std::ostream&amp; <a class="code hl_function" href="namespaceipc_1_1session_1_1sync__io.html#a940cd2019ccc199984a9be7102885f2d">operator&lt;&lt;</a>(std::ostream&amp; os,</div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span>                         <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1session_1_1sync__io_1_1Session__server__adapter.html">Session_server_adapter&lt;Session_server&gt;</a>&amp; val);</div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span> </div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span>} <span class="comment">// namespace ipc::session::sync_io</span></div>
<div class="ttc" id="aclassipc_1_1session_1_1Client__session__mv_html"><div class="ttname"><a href="classipc_1_1session_1_1Client__session__mv.html">ipc::session::Client_session_mv</a></div><div class="ttdoc">Implements Session concept on the Client_app end: a Session_mv that first achieves PEER state by conn...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2client__session_8hpp_source.html#l00143">client_session.hpp:145</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Server__session__mv_html"><div class="ttname"><a href="classipc_1_1session_1_1Server__session__mv.html">ipc::session::Server_session_mv</a></div><div class="ttdoc">Implements Session concept on the Server_app end: a Session that is emitted in almost-PEER state by l...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2server__session_8hpp_source.html#l00122">server_session.hpp:124</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__mv_html"><div class="ttname"><a href="classipc_1_1session_1_1Session__mv.html">ipc::session::Session_mv</a></div><div class="ttdoc">Implements the Session concept when it is in PEER state.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session_8hpp_source.html#l00504">session.hpp:505</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__server_html"><div class="ttname"><a href="classipc_1_1session_1_1Session__server.html">ipc::session::Session_server</a></div><div class="ttdoc">To be instantiated typically once in a given process, an object of this type asynchronously listens f...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2session__server_8hpp_source.html#l00193">session_server.hpp:197</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1sync__io_1_1Client__session__adapter_html"><div class="ttname"><a href="classipc_1_1session_1_1sync__io_1_1Client__session__adapter.html">ipc::session::sync_io::Client_session_adapter</a></div><div class="ttdoc">sync_io-pattern counterpart to async-I/O-pattern session::Client_session types and all their SHM-awar...</div><div class="ttdef"><b>Definition:</b> <a href="client__session__adapter_8hpp_source.html#l00083">client_session_adapter.hpp:86</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1sync__io_1_1Server__session__adapter_html"><div class="ttname"><a href="classipc_1_1session_1_1sync__io_1_1Server__session__adapter.html">ipc::session::sync_io::Server_session_adapter</a></div><div class="ttdoc">sync_io-pattern counterpart to async-I/O-pattern session::Server_session types and all their SHM-awar...</div><div class="ttdef"><b>Definition:</b> <a href="server__session__adapter_8hpp_source.html#l00082">server_session_adapter.hpp:85</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1sync__io_1_1Session__server__adapter_html"><div class="ttname"><a href="classipc_1_1session_1_1sync__io_1_1Session__server__adapter.html">ipc::session::sync_io::Session_server_adapter</a></div><div class="ttdoc">sync_io-pattern counterpart to async-I/O-pattern session::Session_server types and all their SHM-awar...</div><div class="ttdef"><b>Definition:</b> <a href="session__server__adapter_8hpp_source.html#l00073">session_server_adapter.hpp:74</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html">ipc::util::Shared_name</a></div><div class="ttdoc">String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent entity fr...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00241">shared_name.hpp:242</a></div></div>
<div class="ttc" id="adetail_2session__fwd_8hpp_html"><div class="ttname"><a href="detail_2session__fwd_8hpp.html">session_fwd.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1sync__io_html"><div class="ttname"><a href="namespaceipc_1_1session_1_1sync__io.html">ipc::session::sync_io</a></div><div class="ttdoc">sync_io-pattern counterparts to async-I/O-pattern object types in parent namespace ipc::session.</div><div class="ttdef"><b>Definition:</b> <a href="session__fwd_8hpp_source.html#l00470">session_fwd.hpp:471</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1sync__io_html_a940cd2019ccc199984a9be7102885f2d"><div class="ttname"><a href="namespaceipc_1_1session_1_1sync__io.html#a940cd2019ccc199984a9be7102885f2d">ipc::session::sync_io::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Server_session_adapter&lt; Session &gt; &amp;val)</div><div class="ttdoc">Prints string representation of the given Server_session_adapter to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="server__session__adapter_8hpp_source.html#l00213">server_session_adapter.hpp:213</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html"><div class="ttname"><a href="namespaceipc_1_1session.html">ipc::session</a></div><div class="ttdoc">Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00026">app.cpp:27</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_a0eac87b284d50832334d819a8877cbaa"><div class="ttname"><a href="namespaceipc_1_1session.html#a0eac87b284d50832334d819a8877cbaa">ipc::session::ensure_resource_owner_is_app</a></div><div class="ttdeci">void ensure_resource_owner_is_app(flow::log::Logger *logger_ptr, const fs::path &amp;path, const App &amp;app, Error_code *err_code)</div><div class="ttdoc">Utility, used internally but exposed in public API in case it is of general use, that checks that the...</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00031">app.cpp:31</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_a6b2f9a90ac9cc5098d9b90e7f547c97e"><div class="ttname"><a href="namespaceipc_1_1session.html#a6b2f9a90ac9cc5098d9b90e7f547c97e">ipc::session::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const App &amp;val)</div><div class="ttdoc">Prints string representation of the given App to the given ostream.</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00124">app.cpp:124</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_a6d07d9996af19e57eb42416e914110ea"><div class="ttname"><a href="namespaceipc_1_1session.html#a6d07d9996af19e57eb42416e914110ea">ipc::session::Shared_name</a></div><div class="ttdeci">util::Shared_name Shared_name</div><div class="ttdoc">Convenience alias for the commonly used type util::Shared_name.</div><div class="ttdef"><b>Definition:</b> <a href="session__fwd_8hpp_source.html#l00245">session_fwd.hpp:245</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_ade2b302f1a3623e8adc9694568d94d2c"><div class="ttname"><a href="namespaceipc_1_1session.html#ade2b302f1a3623e8adc9694568d94d2c">ipc::session::Session_token</a></div><div class="ttdeci">transport::struc::Session_token Session_token</div><div class="ttdoc">Convenience alias for the commonly used type transport::struc::Session_token.</div><div class="ttdef"><b>Definition:</b> <a href="session__fwd_8hpp_source.html#l00248">session_fwd.hpp:248</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_html_a6751c05fb6582a34c7c47ac470c4a48b"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc.html#a6751c05fb6582a34c7c47ac470c4a48b">ipc::transport::struc::Session_token</a></div><div class="ttdeci">boost::uuids::uuid Session_token</div><div class="ttdoc">A type used by struc::Channel for internal safety/security/auth needs.</div><div class="ttdef"><b>Definition:</b> <a href="struc__fwd_8hpp_source.html#l00113">struc_fwd.hpp:113</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="anative__handle_8hpp_html"><div class="ttname"><a href="native__handle_8hpp.html">native_handle.hpp</a></div></div>
<div class="ttc" id="astruc__fwd_8hpp_html"><div class="ttname"><a href="struc__fwd_8hpp.html">struc_fwd.hpp</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1App_html"><div class="ttname"><a href="structipc_1_1session_1_1App.html">ipc::session::App</a></div><div class="ttdoc">A description of an application in this ipc::session inter-process communication universe.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00077">app.hpp:78</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Client__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Client__app.html">ipc::session::Client_app</a></div><div class="ttdoc">An App that is used as a client in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00184">app.hpp:185</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Server__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Server__app.html">ipc::session::Server_app</a></div><div class="ttdoc">An App that is used as a server in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00205">app.hpp:206</a></div></div>
<div class="ttc" id="astructipc_1_1util_1_1Native__handle_html"><div class="ttname"><a href="structipc_1_1util_1_1Native__handle.html">ipc::util::Native_handle</a></div><div class="ttdoc">A monolayer-thin wrapper around a native handle, a/k/a descriptor a/k/a FD.</div><div class="ttdef"><b>Definition:</b> <a href="native__handle_8hpp_source.html#l00062">native_handle.hpp:63</a></div></div>
<div class="ttc" id="atransport__fwd_8hpp_html"><div class="ttname"><a href="transport__fwd_8hpp.html">transport_fwd.hpp</a></div></div>
<div class="ttc" id="autil__fwd_8hpp_html"><div class="ttname"><a href="util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
